﻿/*

The MIT License

Copyright (c) 2010 Cartesian Analytics, Inc. 

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

*/

namespace Pipra.Math
{
    /// <summary>
    /// A square matrix which has the same number of rows as columns.
    /// </summary>
    /// <typeparam name="TValue">The element type of the matrix.</typeparam>
    /// <remarks>
    /// All matrix classes and structs which implement this interface must have the same number of rows as columns.
    /// </remarks>
    public interface IMatrixSquare<TValue> :
        IMatrix<TValue>
    {
        /// <summary>
        /// Gets the order of the square matrix.
        /// </summary>
        int Order { get; }
        /// <summary>
        /// Sets the elements of this matrix to that of the identity matrix.
        /// </summary>
        void SetIdentity();
        /// <summary>
        /// Calculates the determinant of the matrix.
        /// </summary>
        /// <returns>The determinant.</returns>
        TValue GetDeterminant();
        /// <summary>
        /// Inverts this matrix.
        /// </summary>
        void Invert();
        /// <summary>
        /// Generates a matrix which is the inverse.
        /// </summary>
        /// <returns>The inverse of the matrix.</returns>
        IMatrixSquare<TValue> GetInverse();
        /// <summary>
        /// Transposes this matrix.
        /// </summary>
        void Transpose();
        /// <summary>
        /// Generates a matrix which is the transpose.
        /// </summary>
        /// <returns>The transpose of the matrix.</returns>
        IMatrixSquare<TValue> GetTransposed();

    }
}
